<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Interface: ISlideThumbnail</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div class="header">
    <div class="logo">
        <img class="logo_img" src="images/logo.png" alt="logo">
        <h1>iSpring JavaScript API Documentaion</h1>
        <div class="clear"></div>
    </div>
    <div class="header_border">        
    </div>
</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Interfaces</h3><ul><li><a href="ispring.presenter.presentation.assets.ISlideThumbnail.html">ISlideThumbnail</a></li></ul><h3>Namespaces</h3><ul><li><a href="ispring.events.html">ispring.events</a></li><li><a href="ispring.presenter.player.html">ispring.presenter.player</a></li><li><a href="ispring.presenter.player.clock.html">ispring.presenter.player.clock</a></li><li><a href="ispring.presenter.player.narration.html">ispring.presenter.player.narration</a></li><li><a href="ispring.presenter.player.narration.audio.html">ispring.presenter.player.narration.audio</a></li><li><a href="ispring.presenter.player.narration.video.html">ispring.presenter.player.narration.video</a></li><li><a href="ispring.presenter.player.restriction.html">ispring.presenter.player.restriction</a></li><li><a href="ispring.presenter.player.sound.html">ispring.presenter.player.sound</a></li><li><a href="ispring.presenter.player.transitions.html">ispring.presenter.player.transitions</a></li><li><a href="ispring.presenter.presentation.html">ispring.presenter.presentation</a></li><li><a href="ispring.presenter.presentation.assets.html">ispring.presenter.presentation.assets</a></li><li><a href="ispring.presenter.presentation.meta.html">ispring.presenter.presentation.meta</a></li><li><a href="ispring.presenter.presentation.narration.html">ispring.presenter.presentation.narration</a></li><li><a href="ispring.presenter.presentation.resources.html">ispring.presenter.presentation.resources</a></li><li><a href="ispring.presenter.presentation.resources.references.html">ispring.presenter.presentation.resources.references</a></li><li><a href="ispring.presenter.presentation.settings.html">ispring.presenter.presentation.settings</a></li><li><a href="ispring.presenter.presentation.slides.html">ispring.presenter.presentation.slides</a></li><li><a href="ispring.utils.assets.html">ispring.utils.assets</a></li></ul>
</nav>

<div id="main">
    



<section>

<header>
    
        <h5 class="left">
            interface
                
        </h5>
        <span class="ancestors">
            <a href="ispring.html">ispring</a><a href="ispring.presenter.html">.presenter</a><a href="ispring.presenter.presentation.html">.presentation</a><a href="ispring.presenter.presentation.assets.html">.assets</a>.ISlideThumbnail
        </span>
        <div class="clear"></div>
    
    
</header>

<article>
    <div class="container-overview">
    

    
        

<dd class="method_description">

    

    

    

    

    
<dl class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>


    

    

    

    

    

    

    
</dd>

    
    </div>

    
        <h3 class="subsection-title">Extends</h3>

        <ul class="extendsList">
            <li><a href="ispring.utils.assets.IGraphicAsset.html">ispring.utils.assets.IGraphicAsset</a></li>
        </ul>
    

    

    

    

    

     

    

    
        <h3 class="subsection-title">Methods</h3>

        <dl>
            

<dt>
    <h4 class="name" id="createImgInstance"><span class="type-signature"></span>createImgInstance<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {HTMLImageElement}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Creates a new <code>HTMLImageElement</code> instance with the graphic asset content.
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IGraphicAsset.html#createImgInstance">ispring.utils.assets.IGraphicAsset#createImgInstance</a>
    </li></dd>
    

    

    

    

    

    

    

    

    
    <dt class="tag-see">See also</dt>
    <dd class="tag-see">
        <ul>
            <li class="seeAlso"><a href="ispring.utils.assets.IAsset.html#isLoaded">ispring.utils.assets.IAsset#isLoaded</a></li>
        </ul>
    </dd>
    

    
</dl>


    

    

    

    

    
    <h5>Throws:</h5>
    
            

<dt>
    <dl>
        
<span class="param-type">Error</span>

 -
        <span class="param-desc reset-margin">
             Throws if the asset is not loaded.
        </span>
   </dl>
</dt>



        

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>Type: 
<span class="param-type">HTMLImageElement</span>

</dt>
</dl>

        

    
</dd>

        
            

<dt>
    <h4 class="name" id="createInstance"><span class="type-signature"></span>createInstance<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {HTMLCanvasElement}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Creates a new <code>HTMLCanvasElement</code> instance with the graphic asset content.
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IGraphicAsset.html#createInstance">ispring.utils.assets.IGraphicAsset#createInstance</a>
    </li></dd>
    

    

    

    

    

    

    

    

    
    <dt class="tag-see">See also</dt>
    <dd class="tag-see">
        <ul>
            <li class="seeAlso"><a href="ispring.utils.assets.IAsset.html#isLoaded">ispring.utils.assets.IAsset#isLoaded</a></li>
        </ul>
    </dd>
    

    
</dl>


    

    

    

    

    
    <h5>Throws:</h5>
    
            

<dt>
    <dl>
        
<span class="param-type">Error</span>

 -
        <span class="param-desc reset-margin">
             Throws if the asset is not loaded.
        </span>
   </dl>
</dt>



        

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>Type: 
<span class="param-type">HTMLCanvasElement</span>

</dt>
</dl>

        

    
</dd>

        
            

<dt>
    <h4 class="name" id="height"><span class="type-signature"></span>height<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Returns the graphic asset height, in pixels.
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IGraphicAsset.html#height">ispring.utils.assets.IGraphicAsset#height</a>
    </li></dd>
    

    

    

    

    

    

    

    

    
    <dt class="tag-see">See also</dt>
    <dd class="tag-see">
        <ul>
            <li class="seeAlso"><a href="ispring.utils.assets.IAsset.html#isLoaded">ispring.utils.assets.IAsset#isLoaded</a></li>
        </ul>
    </dd>
    

    
</dl>


    

    

    

    

    
    <h5>Throws:</h5>
    
            

<dt>
    <dl>
        
<span class="param-type">Error</span>

 -
        <span class="param-desc reset-margin">
             Throws if the asset is not loaded.
        </span>
   </dl>
</dt>



        

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>Type: 
<span class="param-type">number</span>

</dt>
</dl>

        

    
</dd>

        
            

<dt>
    <h4 class="name" id="isLoaded"><span class="type-signature"></span>isLoaded<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Indicates whether the asset has been loaded.<p>Use the <a href="ispring.utils.assets.IAsset.html#load"><code>load()</code></a> method to load the asset.</p>
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IAsset.html#isLoaded">ispring.utils.assets.IAsset#isLoaded</a>
    </li></dd>
    

    

    

    

    

    

    

    

    
    <dt class="tag-see">See also</dt>
    <dd class="tag-see">
        <ul>
            <li class="seeAlso"><a href="ispring.utils.assets.IAsset.html#loadCompleteEvent">ispring.utils.assets.IAsset#loadCompleteEvent</a></li>
        </ul>
    </dd>
    

    
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>Type: 
<span class="param-type">boolean</span>

</dt>
</dl>

        

    
</dd>

        
            

<dt>
    <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Loads the asset asynchronously if it hasn't been loaded.<p>Use the <a href="ispring.utils.assets.IAsset.html#loadCompleteEvent"><code>loadCompleteEvent()</code></a> method to get the<a href="ispring.events.IEventDispatcher.html"><code>IEventDispatcher</code></a> interface allowing to add or remove the <code>loadComplete</code>event handler.</p>
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IAsset.html#load">ispring.utils.assets.IAsset#load</a>
    </li></dd>
    

    

    

    

    

    

    

    

    

    
</dl>


    

    

    

    

    

    

    
</dd>

        
            

<dt>
    <h4 class="name" id="loadCompleteEvent"><span class="type-signature"></span>loadCompleteEvent<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {<a href="ispring.events.IEventDispatcher.html">ispring.events.IEventDispatcher</a>}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Returns the <a href="ispring.events.IEventDispatcher.html"><code>IEventDispatcher</code></a> interface dispatching the <code>loadComplete</code>event when the asset has been loaded.<p>The returned event dispatcher passes the asset reference to the listener function. See the following example:</p><pre>	 var asset;	 // ...	 asset.loadCompleteEvent().addHandler(function(theAsset){		 window.console.log("The asset has been loaded successfully");	 });	 asset.load();</pre>
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IAsset.html#loadCompleteEvent">ispring.utils.assets.IAsset#loadCompleteEvent</a>
    </li></dd>
    

    

    

    

    

    

    

    

    

    
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    The <a href="ispring.events.IEventDispatcher.html"><code>IEventDispatcher</code></a> interface dispatching the <code>loadComplete</code> event when the asset has been loaded.
</div>



<dl>
    <dt>Type: 
<span class="param-type"><a href="ispring.events.IEventDispatcher.html">ispring.events.IEventDispatcher</a></span>

</dt>
</dl>

        

    
</dd>

        
            

<dt>
    <h4 class="name" id="loadFailedEvent"><span class="type-signature"></span>loadFailedEvent<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {<a href="ispring.events.IEventDispatcher.html">ispring.events.IEventDispatcher</a>}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Returns the <a href="ispring.events.IEventDispatcher.html"><code>IEventDispatcher</code></a> interface dispatching the <code>loadFailed</code>event when the asset loading has failed.																		   N<p>The returned event dispatcher passes the asset reference to the listener function. See the following example:</p><pre>	 var asset;	 // ...	 asset.loadFailedEvent().addHandler(function(theAsset){		 window.console.log("The asset loading has failed:");	 });	 asset.load();</pre>
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IAsset.html#loadFailedEvent">ispring.utils.assets.IAsset#loadFailedEvent</a>
    </li></dd>
    

    

    

    

    

    

    

    

    

    
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    The <a href="ispring.events.IEventDispatcher.html"><code>IEventDispatcher</code></a> interface dispatching the <code>loadFailed</code> event when the asset loading has failed.
</div>



<dl>
    <dt>Type: 
<span class="param-type"><a href="ispring.events.IEventDispatcher.html">ispring.events.IEventDispatcher</a></span>

</dt>
</dl>

        

    
</dd>

        
            

<dt>
    <h4 class="name" id="loadProgressEvent"><span class="type-signature"></span>loadProgressEvent<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {<a href="ispring.events.IEventDispatcher.html">ispring.events.IEventDispatcher</a>}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Returns the <a href="ispring.events.IEventDispatcher.html"><code>IEventDispatcher</code></a> interface dispatching the <code>loadProgress</code>event when the asset loading progress is updated.<p>The returned event dispatcher passes the asset reference to the listener function. See the following example:</p><pre>	 var asset;	 // ...	 asset.loadProgressEvent().addHandler(function(theAsset){		 window.console.log("The asset loading progress is:", theAsset.progress());	 });	 asset.load();</pre>
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IAsset.html#loadProgressEvent">ispring.utils.assets.IAsset#loadProgressEvent</a>
    </li></dd>
    

    

    

    

    

    

    

    

    

    
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    The <a href="ispring.events.IEventDispatcher.html"><code>IEventDispatcher</code></a> interface dispatching the <code>loadFailed</code> event when the asset loading progress is updated.
</div>



<dl>
    <dt>Type: 
<span class="param-type"><a href="ispring.events.IEventDispatcher.html">ispring.events.IEventDispatcher</a></span>

</dt>
</dl>

        

    
</dd>

        
            

<dt>
    <h4 class="name" id="path"><span class="type-signature"></span>path<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Returns the graphic asset path.
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IGraphicAsset.html#path">ispring.utils.assets.IGraphicAsset#path</a>
    </li></dd>
    

    

    

    

    

    

    

    

    

    
</dl>


    

    

    

    

    
    <h5>Throws:</h5>
    
            

<dt>
    <dl>
        
<span class="param-type">Error</span>

 -
        <span class="param-desc reset-margin">
             Throws if the asset is not loaded.
        </span>
   </dl>
</dt>



        

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>Type: 
<span class="param-type">string</span>

</dt>
</dl>

        

    
</dd>

        
            

<dt>
    <h4 class="name" id="progress"><span class="type-signature"></span>progress<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Returns the asset loading progress in the range [0...1].
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IAsset.html#progress">ispring.utils.assets.IAsset#progress</a>
    </li></dd>
    

    

    

    

    

    

    

    

    

    
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>Type: 
<span class="param-type">number</span>

</dt>
</dl>

        

    
</dd>

        
            

<dt>
    <h4 class="name" id="unload"><span class="type-signature"></span>unload<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Unloads the loaded asset or stops loading if the asset is being loaded.
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IAsset.html#unload">ispring.utils.assets.IAsset#unload</a>
    </li></dd>
    

    

    

    

    

    

    

    

    

    
</dl>


    

    

    

    

    

    

    
</dd>

        
            

<dt>
    <h4 class="name" id="width"><span class="type-signature"></span>width<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>

    
</dt>

<dd class="method_description">

    
    <div class="description">
        Returns the graphic asset width, in pixels.
    </div>
    

    

    

    

    
<dl class="details">
    

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="ispring.utils.assets.IGraphicAsset.html#width">ispring.utils.assets.IGraphicAsset#width</a>
    </li></dd>
    

    

    

    

    

    

    

    

    
    <dt class="tag-see">See also</dt>
    <dd class="tag-see">
        <ul>
            <li class="seeAlso"><a href="ispring.utils.assets.IAsset.html#isLoaded">ispring.utils.assets.IAsset#isLoaded</a></li>
        </ul>
    </dd>
    

    
</dl>


    

    

    

    

    
    <h5>Throws:</h5>
    
            

<dt>
    <dl>
        
<span class="param-type">Error</span>

 -
        <span class="param-desc reset-margin">
             Throws if the asset is not loaded.
        </span>
   </dl>
</dt>



        

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>Type: 
<span class="param-type">number</span>

</dt>
</dl>

        

    
</dd>

        </dl>
    

    

    
</article>

</section>




</div>

<br clear="both">

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>